Remove(IList<Guid>) Method

In This Topic

Remove sessions from the repository and all folders by its Id

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function Remove( _
   ByVal sessionIds As IList(Of Guid) _
) As Boolean

public bool Remove( 
   IList<Guid> sessionIds
)

Parameters

sessionIds: An array of the unique Ids of the sessions to be removed

Return Value

True if a session existed and was removed, false otherwise.

Remarks

If no sessions are found with the specified Ids then no exception is thrown. Instead, false is returned. If at least one session is found and removed True is returned. If there is a problem removing one or more of the specified sessions (and it exists) then an exception is thrown. The sessions will be removed from all folders that may reference it as well as user history and preferences.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

LocalRepository Class
LocalRepository Members
Overload List

Send Feedback